icon.htmlHTMLudogeûπùΔ£πùΔ£ÅÅá Monkeybread Realbasic plugin - Documentation - Icon

MBS Plugin Documentation

This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.

This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.

The list of the themes Global methods by category Global methods by name The list of the classes The list of the controls

class Icon
class, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: A class for an icon on Mac OS.

DrawIcon(g as graphicsx as integer,y as integer,w as integer,h as integer[,align as integer[,transform as integer]])
method, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: Draws the icon.
Notes:
Align and Transform are optional parameters.

The coordinates inside the graphics objects are absolute to the picture or window where the graphics object came from.

Align constants:
None 0
VerticalCenter 1
Top 2
Bottom 3
HorizontalCenter 4
AbsoluteCenter 5
CenterTop 6
CenterBottom 7
Left 8
CenterLeft 9
TopLeft 10
BottomLeft 11
Right 12
CenterRight 13
TopRight 14
BottomRight 15

Transform constants:
None 0
Disabled 1
Offline 2
Open 3
Label1 &h0100
Label2 &h0200
Label3 &h0300
Label4 &h0400
Label5 &h0500
Label6 &h0600
Label7 &h0700
Selected &h4000
SelectedDisabled &h4001
SelectedOffline &h4002
SelectedOpen &h4003

handle as integer
property, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: The handle of this icon in memory.

Huge1BitMask as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Huge32BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Huge4BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Huge8BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Huge8BitMask as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Icon(f as folderitem)
constructor, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: Loads the icon for this file/folder/volume.
Notes: The example "GetIcon.rb" shows how to get the file icons.

Icon(type as string, creator as string)
constructor, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: Loads the icon for this type and creator code combination.
Notes: The example "GetIcon.rb" shows how to get the predefined icons from the system.

Large1BitMask as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Large32BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Large4BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Large8BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Large8BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

PointIcon(pointx as integer,pointy as integer,x as integer,y as integer,width as integer,height as integer,align as integer) as boolean
method, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: Tests wether a point is inside the icon's picture.
Notes:
The coordinates for pointx/pointy and x/y must be in the same system.

Align constants:
None 0
VerticalCenter 1
Top 2
Bottom 3
HorizontalCenter 4
AbsoluteCenter 5
CenterTop 6
CenterBottom 7
Left 8
CenterLeft 9
TopLeft 10
BottomLeft 11
Right 12
CenterRight 13
TopRight 14
BottomRight 15

RectInIcon(rectx as integer,recty as integer,rectwidth as integer,rectheight as integer,x as integer,y as integer,width as integer,height as integer,align as integer) as boolean
method, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: Tests wether a rectangle is inside the icon's picture.
Notes:
The coordinates for both rectangles must be in the same coordinate system.

Align constants:
None 0
VerticalCenter 1
Top 2
Bottom 3
HorizontalCenter 4
AbsoluteCenter 5
CenterTop 6
CenterBottom 7
Left 8
CenterLeft 9
TopLeft 10
BottomLeft 11
Right 12
CenterRight 13
TopRight 14
BottomRight 15

This call may fail in some RB versions because of the count of parameters.

Small1BitMask as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Small32BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Small4BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Small8BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Small8BitMask as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Thumbnail32BitData as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

Thumbnail8BitMask as picture
method, Icon Service Plugin version: 2.6 Mi, 4. Sep 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Returns allways nil.
Function: If such an icon is included in this icon collection, this function returns it.

valid as boolean
property, Icon Service Plugin version: 2.6 Fr, 30. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Were the constructors successfull?

Contact

Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.

This resource fork intentionally left blank ˇˇ